<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>functions</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;functions
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="functions-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="functions-module.html">Module functions</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment">#coding: utf-8</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring">'''Helper functions for normalization, conversion, etc.</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">math</tt> <tt class="py-keyword">import</tt> <tt class="py-name">pi</tt><tt class="py-op">,</tt> <tt class="py-name">fabs</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"> </tt>
<a name="sgn"></a><div id="sgn-def"><a name="L8"></a><tt class="py-lineno"> 8</tt> <a class="py-toggle" href="#" id="sgn-toggle" onclick="return toggle('sgn');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="functions-module.html#sgn">sgn</a><tt class="py-op">(</tt><tt class="py-param">x</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="sgn-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="sgn-expanded"><a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line">  <tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-docstring">  Return sgn(x), that is: 1 if x is positive, -1 if x is negative, 0 if</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-docstring">  x is 0.</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">  """</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line">  <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">x</tt> <tt class="py-op">/</tt> <tt class="py-name">fabs</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">)</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line">  <tt class="py-keyword">except</tt> <tt class="py-name">ZeroDivisionError</tt><tt class="py-op">:</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-number">0</tt> </tt>
</div><a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"> </tt>
<a name="deg2rad"></a><div id="deg2rad-def"><a name="L19"></a><tt class="py-lineno">19</tt> <a class="py-toggle" href="#" id="deg2rad-toggle" onclick="return toggle('deg2rad');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="functions-module.html#deg2rad">deg2rad</a><tt class="py-op">(</tt><tt class="py-param">deg</tt><tt class="py-op">,</tt> <tt class="py-param">normalize</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="deg2rad-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="deg2rad-expanded"><a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">  <tt class="py-docstring">"""</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-docstring">  Convert angle from degrees to radians.</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"><tt class="py-docstring">  @type  deg: float</tt> </tt>
<a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt class="py-docstring">  @param deg: Angle in degrees.</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-docstring">  @type  normalize: bool</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"><tt class="py-docstring">  @param normalize: If true translate returned value to [0, 2pi)</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line"><tt class="py-docstring">  """</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line"> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line">  <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">deg</tt><tt class="py-op">:</tt> <tt class="py-name">deg</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line"> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line">  <tt class="py-name">rad</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> <tt class="py-op">*</tt> <tt class="py-name">pi</tt> <tt class="py-op">*</tt> <tt class="py-name">deg</tt> <tt class="py-op">/</tt> <tt class="py-number">360</tt> </tt>
<a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">  <tt class="py-keyword">return</tt> <tt class="py-name">rad</tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">normalize</tt> <tt class="py-keyword">else</tt> <tt id="link-0" class="py-name" targets="Function functions.normalize_rad()=functions-module.html#normalize_rad"><a title="functions.normalize_rad" class="py-name" href="#" onclick="return doclink('link-0', 'normalize_rad', 'link-0');">normalize_rad</a></tt><tt class="py-op">(</tt><tt class="py-name">rad</tt><tt class="py-op">)</tt> </tt>
</div><a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line"> </tt>
<a name="rad2deg"></a><div id="rad2deg-def"><a name="L35"></a><tt class="py-lineno">35</tt> <a class="py-toggle" href="#" id="rad2deg-toggle" onclick="return toggle('rad2deg');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="functions-module.html#rad2deg">rad2deg</a><tt class="py-op">(</tt><tt class="py-param">rad</tt><tt class="py-op">,</tt> <tt class="py-param">normalize</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="rad2deg-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="rad2deg-expanded"><a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">  <tt class="py-docstring">"""</tt> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line"><tt class="py-docstring">  Convert angle from radians to degrees.</tt> </tt>
<a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line"><tt class="py-docstring">  @type  rad: float</tt> </tt>
<a name="L40"></a><tt class="py-lineno">40</tt>  <tt class="py-line"><tt class="py-docstring">  @param rad: Angle in radians.</tt> </tt>
<a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line"><tt class="py-docstring">  @type  normalize: bool</tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line"><tt class="py-docstring">  @param normalize: If true translate returned value to [0, 360)</tt> </tt>
<a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line"><tt class="py-docstring">  """</tt> </tt>
<a name="L45"></a><tt class="py-lineno">45</tt>  <tt class="py-line"> </tt>
<a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">  <tt class="py-name">deg</tt> <tt class="py-op">=</tt> <tt class="py-number">360</tt> <tt class="py-op">*</tt> <tt class="py-name">rad</tt> <tt class="py-op">/</tt> <tt class="py-number">2</tt> <tt class="py-op">/</tt> <tt class="py-name">pi</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">  <tt class="py-keyword">return</tt> <tt class="py-name">deg</tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">normalize</tt> <tt class="py-keyword">else</tt> <tt class="py-name">deg</tt> <tt class="py-op">%</tt> <tt class="py-number">360</tt> </tt>
</div><a name="L48"></a><tt class="py-lineno">48</tt>  <tt class="py-line"> </tt>
<a name="normalize_rad"></a><div id="normalize_rad-def"><a name="L49"></a><tt class="py-lineno">49</tt> <a class="py-toggle" href="#" id="normalize_rad-toggle" onclick="return toggle('normalize_rad');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="functions-module.html#normalize_rad">normalize_rad</a><tt class="py-op">(</tt><tt class="py-param">rad</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="normalize_rad-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="normalize_rad-expanded"><a name="L50"></a><tt class="py-lineno">50</tt>  <tt class="py-line">  <tt class="py-docstring">"""</tt> </tt>
<a name="L51"></a><tt class="py-lineno">51</tt>  <tt class="py-line"><tt class="py-docstring">  Return angle in radians translated to [0, 2pi).</tt> </tt>
<a name="L52"></a><tt class="py-lineno">52</tt>  <tt class="py-line"><tt class="py-docstring">  """</tt> </tt>
<a name="L53"></a><tt class="py-lineno">53</tt>  <tt class="py-line"> </tt>
<a name="L54"></a><tt class="py-lineno">54</tt>  <tt class="py-line">  <tt class="py-keyword">return</tt> <tt class="py-name">rad</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-number">2</tt> <tt class="py-op">*</tt> <tt class="py-name">pi</tt><tt class="py-op">)</tt> </tt>
</div><a name="L55"></a><tt class="py-lineno">55</tt>  <tt class="py-line"> </tt>
<a name="normalize_deg"></a><div id="normalize_deg-def"><a name="L56"></a><tt class="py-lineno">56</tt> <a class="py-toggle" href="#" id="normalize_deg-toggle" onclick="return toggle('normalize_deg');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="functions-module.html#normalize_deg">normalize_deg</a><tt class="py-op">(</tt><tt class="py-param">deg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="normalize_deg-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="normalize_deg-expanded"><a name="L57"></a><tt class="py-lineno">57</tt>  <tt class="py-line">  <tt class="py-docstring">"""</tt> </tt>
<a name="L58"></a><tt class="py-lineno">58</tt>  <tt class="py-line"><tt class="py-docstring">  Return angle in degrees translated to [0, 360).</tt> </tt>
<a name="L59"></a><tt class="py-lineno">59</tt>  <tt class="py-line"><tt class="py-docstring">  """</tt> </tt>
<a name="L60"></a><tt class="py-lineno">60</tt>  <tt class="py-line"> </tt>
<a name="L61"></a><tt class="py-lineno">61</tt>  <tt class="py-line">  <tt class="py-keyword">return</tt> <tt class="py-name">deg</tt> <tt class="py-op">%</tt> <tt class="py-number">360</tt> </tt>
</div><a name="L62"></a><tt class="py-lineno">62</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Thu Jul 31 17:03:03 2008
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
